docs: lead the README with examples + performance#48
Merged
Conversation
Restructure the landing page for first-time visitors: - Quickstart: byte[] round-trip, dictionary train+compress, zero-copy MemorySegment (signatures verified against the 0.6 API) - Performance: surface the publication-grade golden-corpus numbers from docs/benchmarks.md (best-vs-best vs zstd-jni's own zero-copy path: +9-23% throughput on small payloads, allocation tie; allocation-free vs the convenient byte[] APIs) — honest ties included - Sharpen the pitch (dictionary + zero-copy, the two real differentiators) and note the JDK 25 framing (first LTS with stable FFM) - Move Install above Documentation; link the release smoke matrix as per-arch proof Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restructures the README landing page for promotion — examples + performance up front.
Added
byte[]round-trip, dictionary train+compress, zero-copyMemorySegment. Signatures verified against the 0.6 API.docs/benchmarks.md: best-vs-best vs zstd-jni's own zero-copyByteBufferpath (+9.8% compress / +22.9% small decompress / tie on large; ~0 B/op both), plus the allocation-free-vs-byte[]story. Honest ties kept.Changed
Docs only. Numbers are quoted verbatim from the existing benchmark run, not regenerated.
🤖 Generated with Claude Code